home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / SgDial.z / SgDial
Encoding:
Text File  |  2002-10-03  |  17.4 KB  |  331 lines
  1.  
  2.  
  3.  
  4.      DDDDiiiiaaaallll((((3333XXXX))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  DDDDiiiiaaaallll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           SSSSggggDDDDiiiiaaaallll - The Dial widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<SSSSggggmmmm////DDDDiiiiaaaallll....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents the version of Sgm that accompanies
  17.           Motif 2.1.
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.           Dial is used by an application to allow the user to input or
  21.           modify a value from within a range of values.
  22.  
  23.           A Dial has a rectangular region within which a knob or
  24.           pointer graphic is displayed.  The user can modify the
  25.           Dial's value by spinning this knob or pointer.
  26.  
  27.         CCCCllllaaaasssssssseeeessss
  28.           Dial inherits behavior and resources from CCCCoooorrrreeee and PPPPrrrriiiimmmmiiiittttiiiivvvveeee
  29.           classes.
  30.  
  31.           The class pointer is ssssggggDDDDiiiiaaaallllWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  32.  
  33.           The class name is SSSSggggDDDDiiiiaaaallll.
  34.  
  35.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  36.           The following table defines a set of widget resources used
  37.           by the programmer to specify data.  The programmer can also
  38.           set the resource values for the inherited classes to set
  39.           attributes for this widget.  To reference a resource by name
  40.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN, SSSSggggNNNN, XXXXmmmmCCCC,
  41.           or SSSSggggCCCC prefix and use the remaining letters.  To specify one
  42.           of the defined values for a resource in a .Xdefaults file,
  43.           remove the XXXXmmmm prefix and use the remaining letters (in
  44.           either lowercase or uppercase, but include any underscores
  45.           between words).  The codes in the access column indicate if
  46.           the given resource can be set at creation time (C), set by
  47.           using XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G),
  48.           or is not applicable (N/A).
  49.  
  50.                                  SSSSggggDDDDiiiiaaaallll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  51.      NNNNaaaammmmeeee                      CCCCllllaaaassssssss           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  52.      ___________________________________________________________________________
  53.      SgNdialMarkers            SgCMarkers      int              16        CSG
  54.      XmNminimum                XmCMinimum      int              0         CSG
  55.      XmNmaximum                XmCMaximum      int              360       CSG
  56.      SgNstartAngle             SgCStartAngle   int              0         CSG
  57.      SgNangleRange             SgCAngleRange   int              360       CSG
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      DDDDiiiiaaaallll((((3333XXXX))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  DDDDiiiiaaaallll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.      SgNindicatorColor         XmCColor        Pixel            Red       CSG
  75.      XmNvalue                  XmCValue        Position         0         CSG
  76.      SgNmarkerLength           XmCLength       Dimension        8         CSG
  77.      SgNdialForeground         SgCForeground   Pixel            Red       CSG
  78.      SgNdialVisual             SgCDialVisual   SgDialVisual     SgKNOB    CSG
  79.      XmNvalueChangedCallback   XmCCallback     XtCallbackList   NULL      C
  80.      XmNdragCallback           XmCCallback     XtCallbackList   NULL      C
  81.  
  82.  
  83.           SSSSggggNNNNddddiiiiaaaallllMMMMaaaarrrrkkkkeeeerrrrssss
  84.                     Specifies the number of divisions around the
  85.                     perimeter of the dial.  A "tick mark" will be
  86.                     drawn at each division, filled with the color set
  87.                     by SSSSggggNNNNddddiiiiaaaallllFFFFoooorrrreeeeggggrrrroooouuuunnnndddd.
  88.  
  89.           XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm
  90.                     Specifies the dial's maximum value.  XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm
  91.                     must be greater than or equal to XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm.
  92.  
  93.           XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm
  94.                     Specifies the dial's minimum value.  XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm
  95.                     must be greater than or equal to XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm.
  96.  
  97.           SSSSggggNNNNssssttttaaaarrrrttttAAAAnnnngggglllleeee
  98.                     Specifies the whole number angle (0-360) where the
  99.                     dial will start increasing.
  100.  
  101.           SSSSggggNNNNaaaannnngggglllleeeeRRRRaaaannnnggggeeee
  102.                     Specifies the angular range, in degrees, through
  103.                     which the dial is allowed to rotate.  This, in
  104.                     conjunction with XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm and XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm,
  105.                     controls the fineness or coarseness of the dial
  106.                     control.
  107.  
  108.           SSSSggggNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrCCCCoooolllloooorrrr
  109.                     Specifies the color to be used for filling in the
  110.                     center of the dial pointer, in SSSSggggPPPPOOOOIIIINNNNTTTTEEEERRRR mode.
  111.  
  112.           XXXXmmmmNNNNvvvvaaaalllluuuueeee  Specifies the current position of the dial,
  113.                     between XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm and XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm.
  114.  
  115.           SSSSggggNNNNmmmmaaaarrrrkkkkeeeerrrrLLLLeeeennnnggggtttthhhh
  116.                     Specifies the length (in pixels) of each tick mark
  117.                     on the dial.  The width of each tick mark is
  118.                     derived from the length (length/3).
  119.  
  120.           SSSSggggNNNNddddiiiiaaaallllFFFFoooorrrreeeeggggrrrroooouuuunnnndddd
  121.                     Specifies the color to be used for filling in the
  122.                     tick marks around the perimeter of the dial.
  123.  
  124.           SSSSggggNNNNddddiiiiaaaallllVVVViiiissssuuuuaaaallll
  125.                     Specifies the look of the dial, either SSSSggggKKKKNNNNOOOOBBBB or
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      DDDDiiiiaaaallll((((3333XXXX))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  DDDDiiiiaaaallll((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     SSSSggggPPPPOOOOIIIINNNNTTTTEEEERRRR.
  141.  
  142.           XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  143.                     Specifies the list of callbacks that is called
  144.                     when the value of the dial has changed.  The
  145.                     reason sent by the callback is XXXXmmmmCCCCRRRR____VVVVAAAALLLLUUUUEEEE____CCCCHHHHAAAANNNNGGGGEEEEDDDD.
  146.  
  147.           XXXXmmmmNNNNddddrrrraaaaggggCCCCaaaallllllllbbbbaaaacccckkkk
  148.                     Specifies the list of callbacks that is called
  149.                     when the dial position changes as the dial is
  150.                     being spun.  The reason sent by the callback is
  151.                     XXXXmmmmCCCCRRRR____DDDDRRRRAAAAGGGG.
  152.  
  153.  
  154.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  155.           Dial inherits behavior and resources from the following
  156.           superclasses.  For a complete description of each resource,
  157.           refer to the man page for that superclass.
  158.  
  159.                                          XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  160.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  161.      ________________________________________________________________________________________________
  162.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic                CSG
  163.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap             XmUNSPECIFIED_PIXMAP   CSG
  164.      XmNforeground           XmCForeground           Pixel              dynamic                CSG
  165.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL                   C
  166.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic                CSG
  167.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False                  CSG
  168.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap             dynamic                CSG
  169.      XmNhighlightThickness   XmCHighlightThickness   Dimension          0                      CSG
  170.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE                 CSG
  171.      XmNshadowThickness      XmCShadowThickness      Dimension          0                      CSG
  172.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic                CSG
  173.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap             dynamic                CSG
  174.      XmNtraversalOn          XmCTraversalOn          Boolean            False                  CSG
  175.      XmNunitType             XmCUnitType             unsigned char      dynamic                CSG
  176.      XmNuserData             XmCUserData             XtPointer          NULL                   CSG
  177.  
  178.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  179.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  180.      ______________________________________________________________________________________________________________
  181.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  182.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  183.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  184.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  185.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  186.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  187.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  188.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  189.      XmNdepth                        XmCDepth                        int              dynamic                CG
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      DDDDiiiiaaaallll((((3333XXXX))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  DDDDiiiiaaaallll((((3333XXXX))))
  203.  
  204.  
  205.  
  206.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  207.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  208.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  209.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  210.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  211.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  212.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  213.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  214.      XmNx                            XmCPosition                     Position         0                      CSG
  215.      XmNy                            XmCPosition                     Position         0                      CSG
  216.  
  217.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  218.           A pointer to the following structure is passed to each
  219.           callback:
  220.  
  221.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  222.           {{{{
  223.             iiiinnnntttt      _r_e_a_s_o_n;;;;
  224.             XXXXEEEEvvvveeeennnntttt   * _e_v_e_n_t;;;;
  225.             iiiinnnntttt      _p_o_s_i_t_i_o_n;;;;
  226.           }}}} SSSSggggDDDDiiiiaaaallllCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  227.  
  228.  
  229.           _r_e_a_s_o_n Indicates why the callback was invoked
  230.  
  231.           _e_v_e_n_t  Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback
  232.  
  233.           _p_o_s_i_t_i_o_n
  234.                  Is the new dial value
  235.  
  236.  
  237.         BBBBeeeehhhhaaaavvvviiiioooorrrr
  238.           Dial behavior is described below:
  239.  
  240.  
  241.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss or BBBBDDDDrrrraaaagggg PPPPrrrreeeessssssss:
  242.                     Activates the interactive dragging of the dial.
  243.  
  244.           BBBBSSSSeeeelllleeeecccctttt MMMMoooottttiiiioooonnnn or BBBBDDDDrrrraaaagggg MMMMoooottttiiiioooonnnn:
  245.                     Motion events spin the dial to follow the motion
  246.                     of the pointer and call the callbacks for
  247.                     XXXXmmmmNNNNddddrrrraaaaggggCCCCaaaallllllllbbbbaaaacccckkkk.
  248.  
  249.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee or BBBBDDDDrrrraaaagggg RRRReeeelllleeeeaaaasssseeee:
  250.                     If the dial position has changed, the callbacks
  251.                     for XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk are called.
  252.  
  253.  
  254.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  255.           The bindings for virtual keys are vendor specific.  For
  256.           information about bindings for virtual buttons and keys, see
  257.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      DDDDiiiiaaaallll((((3333XXXX))))                  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                  DDDDiiiiaaaallll((((3333XXXX))))
  269.  
  270.  
  271.  
  272.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  273.           PPPPrrrriiiimmmmiiiittttiiiivvvveeee((((3333XXXX)))), CCCCoooorrrreeee((((3333XXXX))))
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 10/3/02)
  328.  
  329.  
  330.  
  331.